<meta charset="utf-8">
(#) Type-safe NavDestinations must be annotated with @kotlinx.serialization.Serializable

!!! ERROR: Type-safe NavDestinations must be annotated with @kotlinx.serialization.Serializable
   This is an error.

Id
:   `MissingSerializableAnnotation`
Summary
:   Type-safe NavDestinations must be annotated with @kotlinx.serialization.Serializable
Severity
:   Error
Category
:   Correctness
Platform
:   Any
Vendor
:   Android Open Source Project
Identifier
:   androidx.navigation.runtime
Feedback
:   https://issuetracker.google.com/issues/new?component=409828
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.7+
Artifact
:   [androidx.navigation:navigation-runtime](androidx_navigation_navigation-runtime.md.html)
Since
:   2.8.3
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt)
Copyright Year
:   2024

The destination needs to be annotated with @Serializable in order for
Navigation library to convert the class or object declaration into a
NavDestination.

(##) Conflicts

This issue id has also been used by other, unrelated lint checks. Issue
id's must be unique, so you cannot combine these libraries. Also defined
in:
* MissingSerializableAnnotation: Type-safe NavDestinations must be annotated with @kotlinx.serialization.Serializable (this issue)
* [MissingSerializableAnnotation from androidx.navigation:navigation-compose:2.9.0-alpha04](MissingSerializableAnnotation.md.html)
* [MissingSerializableAnnotation from androidx.navigation:navigation-common:2.9.0-alpha04](MissingSerializableAnnotation-3.md.html)


(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.navigation:navigation-runtime:2.9.0-alpha04")

// build.gradle
implementation 'androidx.navigation:navigation-runtime:2.9.0-alpha04'

// build.gradle.kts with version catalogs:
implementation(libs.navigation.runtime)

# libs.versions.toml
[versions]
navigation-runtime = "2.9.0-alpha04"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
navigation-runtime = {
    module = "androidx.navigation:navigation-runtime",
    version.ref = "navigation-runtime"
}
```

2.9.0-alpha04 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.navigation:navigation-runtime](androidx_navigation_navigation-runtime.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("MissingSerializableAnnotation")
  fun method() {
     activity(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("MissingSerializableAnnotation")
  void method() {
     activity(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection MissingSerializableAnnotation
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="MissingSerializableAnnotation" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'MissingSerializableAnnotation'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore MissingSerializableAnnotation ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>